<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class VetoableEventListener</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface VetoableEventListener</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A vetoable event listener.</p>
<p class="description"><p>Level 2 only</p><p>A <a href="../../phpContentRepository/Level2/VetoableEventListener.html">VetoableEventListener</a> can be registered via the  <a href="../../phpContentRepository/Level2/ObservationManager.html#methodaddVetoableEventListener">ObservationManager::addVetoableEventListener()</a> method.</p><p>Vetoable event listeners may veto the action that the events represent. If an  <a href="../../phpContentRepository/Level2/Event.html">Event</a> is vetoed, the corresponding action is forbidden by the  repository.</p><p>Vetoable listeners are notified synchronously, and see events prior to the  repository acting upon them. A vetoable listener only sees events for which  the <a href="../../phpContentRepository/Ticket.html">Ticket</a> that registered it has sufficient access rights.</p><p>To veto an event, a class implementing the <a href="../../phpContentRepository/Level2/VetoableEventListener.html">VetoableEventListener</a>  interface returns true from the <a href="../../phpContentRepository/Level2/VetoableEventListener.html#methodonEvent">onEvent()</a> method. If this happens  during a transaction, the transaction is rolled back. If multiple vetoable  listeners are registered, the first listener to veto an event causes the  original operation to fail. No other vetoable listener is invoked.</p></p>
	<ul class="tags">
				<li><span class="field">copyright:</span> Copyright &amp;copy; 2004-2005, Domain51</li>
				<li><span class="field">author:</span> PHP - Travis Swicegood &lt;<a href="mailto:travis@domain51.net">travis@domain51.net</a>&gt;</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_observation_VetoableEventListener_interface_php.html">/observation/VetoableEventListener.interface.php</a> (line <span class="field">55</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
								
				<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#onEvent" title="details" class="method-name">onEvent</a>
											(<span class="var-type">Event</span>&nbsp;<span class="var-name">$event</span>)
									</div>
							</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodonEvent" id="onEvent"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">onEvent</span> (line <span class="line-number">67</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Performs some action upon receipt of the event.</p>
<p class="description"><p>Returning FALSE will cause the operation in question to  proceed,, returning TRUE will veto the operation in question.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			onEvent
		</span>
					(<span class="var-type">Event</span>&nbsp;<span class="var-name">$event</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">object
 The</span>
				<span class="var-name">$event</span><span class="var-description">: <a href="../../phpContentRepository/Level2/Event.html">Event</a> object to check</span>			</li>
				</ul>
		
		
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 31 Dec 2004 10:15:27 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
	</p>
	</div></body>
</html>